<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="IStyleClient,mx.styles.IStyleClient,className,inheritingStyles,nonInheritingStyles,styleDeclaration,clearStyle,getClassStyleDeclarations,getStyle,notifyStyleChangeInChildren,regenerateStyleCache,registerEffects,setStyle" name="keywords">
<title>mx.styles.IStyleClient</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'IStyleClient - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/styles/IStyleClient.html&amp;mx/styles/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Interface&nbsp;IStyleClient</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IStyleClient"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.styles</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IStyleClient extends <a href="ISimpleStyleClient.html">ISimpleStyleClient</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implementors</td><td><a href="../styles/StyleProxy.html">StyleProxy</a>, <a href="../core/UIComponent.html">UIComponent</a></td>
</tr>
</table>
<p></p>
  This interface describes the properties and methods that an object 
  must implement so that it can fully participate in the style subsystem. 
  This interface is implemented by UIComponent.
   <p>If the object does not need to store style values locally, it can 
  implement the <code>ISimpleStyleClient</code> interface instead.</p>
   <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../styles/ISimpleStyleClient.html" target="">mx.styles.ISimpleStyleClient</a>
<br>
<a href="../styles/CSSStyleDeclaration.html" target="">mx.styles.CSSStyleDeclaration</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<div class="showHideLinks">
<div class="hideInheritedProperty" id="hideInheritedProperty">
<a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
</div>
<div class="showInheritedProperty" id="showInheritedProperty">
<a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
</div>
</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#className">className</a> : String<div class="summaryTableDescription">[read-only]
      The name of the component class.</div>
</td><td class="summaryTableOwnerCol">IStyleClient</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#inheritingStyles">inheritingStyles</a> : Object<div class="summaryTableDescription">
      An object containing the inheritable styles for this component.</div>
</td><td class="summaryTableOwnerCol">IStyleClient</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#nonInheritingStyles">nonInheritingStyles</a> : Object<div class="summaryTableDescription">
      An object containing the noninheritable styles for this component.</div>
</td><td class="summaryTableOwnerCol">IStyleClient</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#styleDeclaration">styleDeclaration</a> : <a href="../styles/CSSStyleDeclaration.html">CSSStyleDeclaration</a>
<div class="summaryTableDescription">
      The style declaration used by this object.</div>
</td><td class="summaryTableOwnerCol">IStyleClient</td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="ISimpleStyleClient.html#styleName">styleName</a> : Object<div class="summaryTableDescription">
      The source of this object's style values.</div>
</td><td class="summaryTableOwnerCol"><a href="ISimpleStyleClient.html">ISimpleStyleClient</a></td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<div class="showHideLinks">
<div class="hideInheritedMethod" id="hideInheritedMethod">
<a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
</div>
<div class="showInheritedMethod" id="showInheritedMethod">
<a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
</div>
</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#clearStyle()">clearStyle</a>(styleProp:String):void</div>
<div class="summaryTableDescription">
      Deletes a style property from this component instance.</div>
</td><td class="summaryTableOwnerCol">IStyleClient</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getClassStyleDeclarations()">getClassStyleDeclarations</a>():Array</div>
<div class="summaryTableDescription">
      Returns an Array of CSSStyleDeclaration objects for the type selector
      that applies to this component, or <code>null</code> if none exist.</div>
</td><td class="summaryTableOwnerCol">IStyleClient</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getStyle()">getStyle</a>(styleProp:String):*</div>
<div class="summaryTableDescription">
      Gets a style property that has been set anywhere in this
      component's style lookup chain.</div>
</td><td class="summaryTableOwnerCol">IStyleClient</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#notifyStyleChangeInChildren()">notifyStyleChangeInChildren</a>(styleProp:String, recursive:Boolean):void</div>
<div class="summaryTableDescription">
      Propagates style changes to the children of this component.</div>
</td><td class="summaryTableOwnerCol">IStyleClient</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#regenerateStyleCache()">regenerateStyleCache</a>(recursive:Boolean):void</div>
<div class="summaryTableDescription">
      Sets up the internal style cache values so that the <code>getStyle()</code> 
      method functions.</div>
</td><td class="summaryTableOwnerCol">IStyleClient</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#registerEffects()">registerEffects</a>(effects:Array):void</div>
<div class="summaryTableDescription">
      Registers the EffectManager as one of the event listeners for each effect event.</div>
</td><td class="summaryTableOwnerCol">IStyleClient</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setStyle()">setStyle</a>(styleProp:String, newValue:*):void</div>
<div class="summaryTableDescription">
      Sets a style property on this component instance.</div>
</td><td class="summaryTableOwnerCol">IStyleClient</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="ISimpleStyleClient.html#styleChanged()">styleChanged</a>(styleProp:String):void</div>
<div class="summaryTableDescription">
      Called when the value of a style property is changed.</div>
</td><td class="summaryTableOwnerCol"><a href="ISimpleStyleClient.html">ISimpleStyleClient</a></td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="className"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">className</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>className:String</code>&nbsp;&nbsp;[read-only]<p>
      The name of the component class.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get className():String</code>
<br>
</div>
<a name="inheritingStyles"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">inheritingStyles</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>inheritingStyles:Object</code>&nbsp;&nbsp;[read-write]<p>
      An object containing the inheritable styles for this component.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get inheritingStyles():Object</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set inheritingStyles(value:Object):void</code>
<br>
</div>
<a name="nonInheritingStyles"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">nonInheritingStyles</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>nonInheritingStyles:Object</code>&nbsp;&nbsp;[read-write]<p>
      An object containing the noninheritable styles for this component.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get nonInheritingStyles():Object</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set nonInheritingStyles(value:Object):void</code>
<br>
</div>
<a name="styleDeclaration"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">styleDeclaration</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>styleDeclaration:<a href="../styles/CSSStyleDeclaration.html">CSSStyleDeclaration</a></code>&nbsp;&nbsp;[read-write]<p>
      The style declaration used by this object.
           </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get styleDeclaration():<a href="../styles/CSSStyleDeclaration.html">CSSStyleDeclaration</a></code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set styleDeclaration(value:<a href="../styles/CSSStyleDeclaration.html">CSSStyleDeclaration</a>):void</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../styles/CSSStyleDeclaration.html" target="">mx.styles.CSSStyleDeclaration</a>
</div>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="clearStyle()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">clearStyle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function clearStyle(styleProp:String):void</code><p>
      Deletes a style property from this component instance.
           </p><p>This does not necessarily cause the <code>getStyle()</code> method to return
      <code>undefined</code>.</p>
           <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">styleProp</span>:String</code> &mdash; Name of the style property.
     </td>
</tr>
</table>
</div>
<a name="getClassStyleDeclarations()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getClassStyleDeclarations</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getClassStyleDeclarations():Array</code><p>
      Returns an Array of CSSStyleDeclaration objects for the type selector
      that applies to this component, or <code>null</code> if none exist.
           </p><p>For example, suppose that component MyButton extends Button.
      This method first looks for a MyButton selector; then, it looks for a Button type selector;
      finally, it looks for a UIComponent type selector.</p>
           <p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Array</code> &mdash; Array of CSSStyleDeclaration objects.
     </td>
</tr>
</table>
</div>
<a name="getStyle()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getStyle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getStyle(styleProp:String):*</code><p>
      Gets a style property that has been set anywhere in this
      component's style lookup chain.
           </p><p>This same method is used to get any kind of style property,
      so the value returned may be a Boolean, String, Number, int,
      uint (for an RGB color), Class (for a skin), or any kind of object.
      Therefore the return type is specified as *.</p>
           <p>If you are getting a particular style property, you will
      know its type and will often want to store the result in a
      variable of that type. You can use either the <code>as</code>
      operator or coercion to do this. For example:</p>
           <pre>
      var backgroundColor:uint = getStyle("backgroundColor") as int;
      
      or
      
      var backgroundColor:uint = int(getStyle("backgroundColor"));
      </pre>
           <p>If the style property has not been set anywhere in the
      style lookup chain, the value returned by the <code>getStyle()</code> method
      is <code>undefined</code>.
      Note that <code>undefined</code> is a special value that is
      not the same as <code>false</code>, the empty String (<code>""</code>),
      <code>NaN</code>, 0, or <code>null</code>.
      No valid style value is ever <code>undefined</code>.
      You can use the static method
      <code>StyleManager.isValidStyleValue()</code>
      to test whether the value was set.</p>
           <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">styleProp</span>:String</code> &mdash; Name of the style property.
           </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>*</code> &mdash; Style value.
     </td>
</tr>
</table>
</div>
<a name="notifyStyleChangeInChildren()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">notifyStyleChangeInChildren</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void</code><p>
      Propagates style changes to the children of this component.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">styleProp</span>:String</code> &mdash; Name of the style property.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">recursive</span>:Boolean</code> &mdash; Whether to propagate the style changes to the children's children. 
     </td>
</tr>
</table>
</div>
<a name="regenerateStyleCache()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">regenerateStyleCache</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function regenerateStyleCache(recursive:Boolean):void</code><p>
      Sets up the internal style cache values so that the <code>getStyle()</code> 
      method functions.
      If this object already has children, then reinitialize the children's
      style caches.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">recursive</span>:Boolean</code> &mdash; Regenerate the proto chains of the children. 
     </td>
</tr>
</table>
</div>
<a name="registerEffects()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">registerEffects</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function registerEffects(effects:Array):void</code><p>
      Registers the EffectManager as one of the event listeners for each effect event.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">effects</span>:Array</code> &mdash; An Array of Strings of effect names. 
     </td>
</tr>
</table>
</div>
<a name="setStyle()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setStyle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setStyle(styleProp:String, newValue:*):void</code><p>
      Sets a style property on this component instance.
           </p><p>This may override a style that was set globally.</p>
           <p>Calling the <code>setStyle()</code> method can result in decreased performance.
      Use it only when necessary.</p>
           <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">styleProp</span>:String</code> &mdash; Name of the style property.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">newValue</span>:*</code> &mdash; New value for the style.
     </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
